feat: Small copy improvements #2189

jancurn · 2026-01-20T10:13:35Z

Note

Docs copy and labeling updates

Platform homepage: retitle to Apify platform documentation and refine Actor definition/intro copy.
API page: change hero heading to Apify API documentation, shorten SDK tab labels to JavaScript/Python, and rename client reference links to Full reference; fix TypeScript capitalization and misc phrasing.
SDK page: tweak hero description and section titles to Apify SDK for JavaScript/Python, adjust descriptions, and rename SDK reference links to Full reference.

UI/CSS

Remove unused .ImageWrapper { overflow: hidden; } rule from API related articles grid.

^{Written by Cursor Bugbot for commit a9bb224. Configure here.}

apify-service-account · 2026-01-20T10:16:34Z

Preview for this PR was built for commit a9bb224 and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T10:44:55Z

Preview for this PR was built for commit 89b23fa and is ready at https://pr-2189.preview.docs.apify.com!

TC-MO

Few thoughts to discuss but nothing that prevents merge. LGTM

TC-MO · 2026-01-20T12:00:10Z

sources/platform/index.mdx

+**Apify** is a cloud platform and marketplace for web data extraction and automation tools called *Actors*.
 >
-> **Actors** are serverless cloud programs running on the Apify platform. They can perform simple actions like filling out web forms or sending emails, or complex operations like crawling millions of web pages or transforming large datasets. Actors can be started manually, via API, or on a schedule, and integrate easily with other applications.
+> **Actors** are serverless cloud programs. They can perform simple actions like filling out web forms or sending emails, or complex operations like crawling millions of web pages or transforming large datasets. Actors can be started manually, via API, or on a schedule, and integrate easily with other applications.


Few thoughts, I'd rather we get rid of the block quote, not 100% if it would be better as docusaurus admonition or maybe just as regular prose. Question is also do we even need Actor explanation here?

TC-MO · 2026-01-20T12:04:10Z

src/pages/api/index.tsx

-                    heading="Apify API"
-                    description={<>Apify API provides programmatic access to the <Link to="/">Apify platform</Link></>}
+                    heading="Apify API documentation"
+                    description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}


I wouldn't use Learn here since this is just the link to the full API ref, we don't teach there anything, and there is no narrative like for example in Academy's courses by @honzajavorek

This one is the top line, imo it works there. Or what other word to put there?

The current "Learn how to use" copy suggests guides or tutorials, but this page is reference documentation (REST API + client libraries).

I'd swap it out for something more developer-focused:

Suggested change

description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}

description={<>Integrate the <Link to="/platform">Apify platform</Link> into your applications using the API or client libraries.</>}

It's developer-focused, outcome-oriented, and accurately cover both the REST API and client libraries covered on this page.

Other options if you prefer:

More general capability focus:

Suggested change

description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}

description={<>Access the <Link to="/platform">Apify platform</Link> programmatically using the API or client libraries.</>}

Most concise (closest to original):

Suggested change

description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}

description={<>Access the <Link to="/platform">Apify platform</Link> programmatically.</>}

I'd go with the "Integrate" version, but all three fix the main issue. Thoughts?

But that sounds like some CTA in Console. Whenever we link to docs from Console or other places, we often call the link "Learn more". IMO "learn" is perfectly okay

E.g. see https://docs.stripe.com/workflows or https://vercel.com/docs/integrations/create-integration/marketplace-api

Yeah I understand the concern, and I appreciate you bringing those examples.

The key difference: those Stripe and Vercel examples link to content that has substantial how-to guides alongside the API reference.

This API landing page links to TWO different content types:

Client libraries - some guided content, but primarily comprehensive API reference (classes, methods, interfaces)

REST API - pure auto-generated OpenAPI spec (endpoint lists, parameters, responses)

Even our own client library docs (docs.apify.com/api/client/js and /python) don't use "Learn" in their descriptions - they describe what the library is rather than what you'll learn. The main selling point across all these sections is the referential documentation, with some guided content as supporting material.

Using "Learn" sets an expectation for tutorial-style instruction, but users primarily come here to look up API endpoints, method signatures, and parameters. If you are not keen on CTA-coded Integrate perhaps:

Suggested change

description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}

description={<>Access the <Link to="/platform">Apify platform</Link> programmatically using the API or client libraries.</>}

would more accurately represent the reference-heavy nature of the content.

Happy to stick with Learn if you prefer, but wanted to flag that the current structure is more reference-focused than those comparison examples.

apify-service-account · 2026-01-20T13:39:40Z

Preview for this PR was built for commit d84064a and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T13:45:31Z

Preview for this PR was built for commit a1bb717 and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T13:48:44Z

Preview for this PR was built for commit 8bbf7fc and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T13:51:48Z

Preview for this PR was built for commit ad845ce and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T14:00:06Z

Preview for this PR was built for commit 684db61 and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T15:42:20Z

Preview for this PR was built for commit aa828257 and is ready at https://pr-2189.preview.docs.apify.com!

TC-MO

It should have been approved in my first message, apologies

TC-MO

fix typos

src/pages/sdk/index.tsx

Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>

apify-service-account · 2026-01-20T22:12:05Z

Preview for this PR was built for commit d49b81ef and is ready at https://pr-2189.preview.docs.apify.com!

Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>

apify-service-account · 2026-01-20T22:15:21Z

Preview for this PR was built for commit bff62a61 and is ready at https://pr-2189.preview.docs.apify.com!

apify-service-account · 2026-01-20T22:19:40Z

Preview for this PR was built for commit bff62a61 and is ready at https://pr-2189.preview.docs.apify.com!

Better copy

a9bb224

jancurn requested a review from TC-MO as a code owner January 20, 2026 10:13

Better copy

89b23fa

TC-MO approved these changes Jan 20, 2026

View reviewed changes

Fix width

d84064a

jancurn added 2 commits January 20, 2026 14:42

Better copy

a1bb717

Better copy

8bbf7fc

Better copy

ad845ce

jancurn requested a review from TC-MO January 20, 2026 13:48

Better copy

684db61

Better copy

aa82825

TC-MO approved these changes Jan 20, 2026

View reviewed changes

TC-MO reviewed Jan 20, 2026

View reviewed changes

src/pages/sdk/index.tsx Outdated Show resolved Hide resolved

src/pages/sdk/index.tsx Outdated Show resolved Hide resolved

jancurn and others added 3 commits January 20, 2026 23:08

Update src/pages/sdk/index.tsx

d49b81e

Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>

Better copy

48352f4

Merge remote-tracking branch 'origin/jan/fixes' into jan/fixes

7a64c41

Update src/pages/sdk/index.tsx

bff62a6

Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>

jancurn merged commit 902cdf0 into master Jan 20, 2026
11 checks passed

jancurn deleted the jan/fixes branch January 20, 2026 22:19

	description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}
	description={<>Integrate the <Link to="/platform">Apify platform</Link> into your applications using the API or client libraries.</>}

	description={<>Learn how to use the <Link to="/platform">Apify platform</Link> programmatically.</>}
	description={<>Access the <Link to="/platform">Apify platform</Link> programmatically using the API or client libraries.</>}

feat: Small copy improvements #2189

feat: Small copy improvements #2189

Conversation

jancurn commented Jan 20, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

TC-MO Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

jancurn Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

TC-MO Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

jancurn Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

TC-MO Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

jancurn Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

jancurn Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

TC-MO Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

Uh oh!

apify-service-account commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jancurn commented Jan 20, 2026 •

edited by cursor bot

Loading

TC-MO Jan 20, 2026 •

edited

Loading